/****************************************************************************
**
** Copyright (C) 2010 Tieto Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Tieto Corporation (info.ostrava@tieto.com)
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial Usage
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Tieto.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Tieto gives you certain additional
** rights.  These rights are described in the Tieto Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you have questions regarding the use of this file, please contact
** Tieto at info.ostrava@tieto.com.
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef CONVOLUTIONFACTORY_H
#define CONVOLUTIONFACTORY_H

#include <QtCore/QObject>
#include <QtXml/QXmlDefaultHandler>
#include <QtCore/QVector>

#include "image.h"

QT_BEGIN_NAMESPACE
class QStringList;
QT_END_NAMESPACE

class ConvolutionModel;
class ConvolutionTask;
class ConvolutionMask;

/**
 * Convoluton mask vector
 */
typedef QList<ConvolutionMask*> ConvolutionMaskList;

/**
 * Convolution factory
 */
class ConvolutionFactory : public QObject, public QXmlDefaultHandler
{
    Q_OBJECT

public:

    /**
     * Default constructor
     * @model model
     */
    ConvolutionFactory(ConvolutionModel &model, QObject *parent=0);

    /**
     * Creates convolution task
     * @param maskName convolution mask name
     * @param srcImg source image
     * @param dstImg convolved image
     * @return convolution task
     */
    ConvolutionTask* createConvolutionTask(const QString maskName, QObject *parent=0);

    /**
     * Gets convolution masks
     * @return convolution masks
     */
    ConvolutionMaskList &getConvolutionMasks();


// From QXmlContentHandler

    virtual bool startElement(const QString &namespaceURI, const QString &localName,
                              const QString &qName, const QXmlAttributes &atts );
    virtual bool endElement(const QString &namespaceURI, const QString &localName,
                            const QString &qName );
    virtual bool characters(const QString &ch);
    virtual bool startDocument();
    virtual bool endDocument();

// From QXmlErrorHandler

    virtual bool error(const QXmlParseException &exception);

private :

    /**
     * Gets convolution mask
     * @param maskName convolution mask name
     * @return convolution mask
     */
    ConvolutionMask* getConvolutionMask(const QString maskName); // TODO

    /**
     * Creates convolution masks
     * @return true, if convolution masks was successful
     */
    bool createConvolutionMasks();

    /**
     * XML parsing states
     */
    enum XmlState {
        ENone = 0,
        EMask,
        EName,
        ERows,
        ECols,
        EData,
        ERow,
        ECol
    };

   /**
    * Current XML parsing state
    */
    XmlState state;

   /**
    * Convolution mask
    */
   ConvolutionMaskList masks;

   // TODO
   QString maskName;
   int maskRows;
   int maskCols;
   int maskRow;
   int maskCol;

   /**
    * Model
    */
   ConvolutionModel &_model;

};

#endif
